/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.xmlrpc;

import javax.xml.namespace.QName;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;


/**
 * XML-RPCの単一の値を持つ型の構文解析を行う全てのクラスの親クラスとなる抽象クラス。<br>
 * (このクラスはスレッドセーフではありません。)<br>
 * (ライブラリの使用者には公開したくない内部処理用のクラスなので、あえてパッケージスコープにしています。)<br>
 */
abstract class AbstractAtomicParser extends AbstractXmlRpcParser {
	//==========================================================
	//フィールド

	/**
	 * 作業用のStringBuilder
	 */
	private StringBuilder sb = null;


	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//抽象メソッド

	/**
	 * 文字列を元にして結果のオブジェクトを設定します。<br>
	 *
	 * @param str 文字列
	 * @throws SAXException SAX例外
	 */
	protected abstract void setResultFromString(String str) throws SAXException;


	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//オーバーライドするメソッド

	/**
	 * 要素の開始通知を受け取ります。<br>
	 *
	 * @param uri 名前空間URI
	 * @param localName 前置修飾子を含まないローカル名
	 * @param qName 接頭辞を持つ修飾名
	 * @param attributes 要素に付加された属性
	 * @throws SAXException SAX例外
	 */
	@Override
	public void startElement(String uri, String localName, String qName,
			Attributes attributes) throws SAXException {
		//タグの階層レベルを+1する
		this.level++;

		//タグの階層レベルが1以外の場合
		if (this.level != 1) {
			//例外を投げる
			throw new SAXParseException("タグの階層構造が不正です。"
					+ new QName(uri, localName), getDocumentLocator());
		}

		//作業用のStringBuilderのインスタンスを生成する
		this.sb = new StringBuilder();
	}

	/**
	 * 要素の終了通知を受け取ります。<br>
	 *
	 * @param uri 名前空間URI
	 * @param localName 前置修飾子を含まないローカル名
	 * @param qName 接頭辞を持つ修飾名
	 * @throws SAXException SAX例外
	 */
	@Override
	public void endElement(String uri, String localName, String qName)
			throws SAXException {
		//タグの階層レベルが1以外の場合
		if (this.level != 1) {
			//例外を投げる
			throw new SAXParseException("タグの階層構造が不正です。"
					+ new QName(uri, localName), getDocumentLocator());
		}

		//タグの階層レベルを-1する
		this.level--;

		//作業用のStringBuilderの内容を元にして結果のオブジェクトを設定する
		setResultFromString(this.sb.toString());

		//作業用のStringBuilderをnullに戻す
		this.sb = null;
	}

	/**
	 * 要素内の文字データの通知を受け取ります。<br>
	 * このクラスの実装では、文字配列の使用範囲に空白文字以外が含まれている場合は例外を投げます。<br>
	 *
	 * @param ch 文字配列
	 * @param start 文字配列内の開始位置
	 * @param length 文字配列から使用される文字数
	 * @throws SAXException SAX例外
	 */
	@Override
	public void characters(char[] ch, int start, int length)
			throws SAXException {
		//作業用のStringBuilderがnullの場合
		if (this.sb == null) {
			//例外を投げる
			throw new SAXParseException("タグの外部に文字列が含まれています。", getDocumentLocator());
		}

		//文字配列の使用範囲を作業用のStringBuilderに追加する
		this.sb.append(ch, start, length);
	}

}
